Inventory - REST API

Table of contents :

• Materials
  • Headers
  • Response
  • Query parameters
  • Example of use

The Sales API supports the following endpoints :

• /rest/v1/materials
• /rest/v1/stock-reservations

Materials

GET /rest/v1/materials

Headers

This endpoint requires the next HTTP header

X-Conversation-Id: {Optional header parameter provided by the client}
X-Webhook-Correlation-Id: {Optional header parameter provided by the client in case of webhook usage}
client_id: {Mandatory header parameter provided by Dali platform}
client_secret: {Mandatory header parameter provided by Dali platform}

Response

The payload returned by the GET operation has the following format:

{
    "header": {
        "apiName": "",
        "apiVersion": "1.0.0",
        "correlationId": "6d540420-d809-11eb-a905-0433c2fabbd0"
    },
    "data": {
        "idocNumber": "",
        "company": "",
        "materialFunction": "",
        "materialId": "",
        "createdDate": "",
        "createdOwner": "",
        "lastUpdateDate": "",
        "lastUpdateOwner": "",
        "maintenanceStatus": "",
        "materialClientLevelDeletion": "",
        "materialType": "",
        "industrysector": "",
        "purchasingFamily": "",
        "oldMaterialNumber": "",
        "baseMeasureUnit": "",
        "purchaseOrderMeasureUnit": "",
        "dimension": "",
        "grossWeight": "",
        "netWeight": "",
        "weightUnit": "",
        "volume": "",
        "volumeUnit": "",
        "internationalMaterialNumber": "",
        "length": "",
        "width": "",
        "height": "",
        "dimensionUnit": "",
        "packagingWeightUnit": "",
        "packagingVolumeUnit": "",
        "modelCode": "",
        "vendorCode": "",
        "totalShelfLife": "",
        "expirationDate": "",
        "materialNumber": "",
        "autorisedPackagingWeightUnit": "",
        "materailAdditionalFields": [
            {
                "serialNumberProfile": ""
            }
        ],
        "materailDescriptions": [
            {
                "materialDescFunction": "",
                "materialDescription": "",
                "languageKey": "",
                "languageISOKey": ""
            }
        ],
        "plantData": [
            {
                "plantDataFunction": "",
                "plant": "",
                "materialPlantLevelDeletion": "",
                "analyticalUnit": "",
                "serialNumberProfile": "",
                "plannedDeliveryTime": "",
                "goodsReceiptProcessingTime": "",
                "reorderPoint": "",
                "safetyStock": "",
                "minLotSize": "",
                "maxLotSize": "",
                "fixedLotSize": "",
                "maxStockLevel": "",
                "discontinuationIndicator": "",
                "effectiveOutData": "",
                "maxStoragePeriod": "",
                "unitMaximumStoragePeriod": "",
                "certificateType": "",
                "militaryGoods": "",
                "minSafetyStock": "",
                "unitMeasureGroup": "",
                "purchasingGroup": "",
                "poQtyRoundVal": "",
                "followUpMat": "",
                "commodityCode": "",
                "materialPlanner": "",
                "storageLocations": [
                    {
                        "storageLocationFunction": "",
                        "storageLocation": "",
                        "materialStorageLocationLevelDeletion": ""
                    }
                ],
                "productionVersions": [
                    {
                        "productionVerisonFunction": "",
                        "productionVerison": "",
                        "productionVerisonRuntimeEnd": ""
                    }
                ]
            }
        ],
        "salesData": [
            {
                "salesDataFunction": "",
                "materialGroup1": "",
                "materialGroup2": "",
                "materialGroup3": "",
                "materialGroup4": "",
                "materialGroup5": ""
            }
        ],
        "materialValuations": [
            {
                "materialValuationFunction": "",
                "valuationArea": "",
                "valuationType": "",
                "deletionFlagAllMaterialData": "",
                "movingAveragePrice": "",
                "standardPrice": "",
                "priceUnit": "",
                "stdPricePreviousPeriod": "",
                "fiscalYearCurrentPeriod": "",
                "currentPeriod": "",
                "priceControlFlag": ""
            }
        ],
        "unitsOfMeasure": [
            {
                "internationalMaterialNumber": "",
                "length": "",
                "width": "",
                "height": "",
                "grossWeight": "",
                "weightUnit": ""
            }
        ],
        "materialsWarehouseNumber": [
            {
                "warehouseNumber": ""
            }
        ],
        "taxData": [
            {
                "taxFunction": "",
                "departureCountry": "",
                "taxCategory": "",
                "taxClassification": ""
            }
        ],
        "configurationData": [
            {
                "extItemNumber": "",
                "extConfigurationId": "",
                "configInstanceNumber": ""
            }
        ],
        "refObjectsToUPS": [
            {
                "objectValidity": ""
            }
        ]
    },
    "pagination": {
        "links": {
            "currentPage": "",
            "firstPage": "",
            "previousPage": "",
            "nextPage": ""
        },
        "currentPage": 1,
        "totalPages": 8
    },
    "error": {}
}

Query parameters

Example of use

Retrieve all materials for company B013 with material type YNEG

GET /rest/v1/materials?plant=B013&materialType=YNEG

Retrieve all materials for company B013 with material type YNEG with pagination

GET /rest/v1/materials?plant=B013&materialType=YNEG&limit=3&page=1

Retrieve material BB013.000000000002 for company B013 with material type YNEG

GET /rest/v1/materials?plant=B013&materialType=YNEG&material=BB013.000000000002

Stock Reservation

POST /rest/v1/stock-reservations

Headers

This endpoint requires the following HTTP header

X-Conversation-Id: {Optional header parameter provided by the client}
client_id: {Mandatory header parameter provided by Dali platform}
client_secret: {Mandatory header parameter provided by Dali platform}

Request

The payload to send in the body of the request in JSON is the following:

{
  "transactionId": "Source ID Of the transcation",
  "sourceSystem": "Source system name (to be declared to be accepted)",
  "companyCode": "CODEX Company code",
  "reservationDate": "Date of reservation",
  "userName": "Name of the User for the reservation",
  "movementType": "type of movement of reservation",
  "projectId": "ID of the project of the reservation",
  "items": [
    {
      "materialNumber": "ID of the material reserved",
      "plant": "Code of the plant",
      "storageLocation": "Code of the storage",
      "batchNumber": "Batch Number",
      "quantity": Quantity reserved,
      "entryUnit": "Unit entry",
      "requirementsDate": "Date of requirement",
      "description": "Material description",
      "movementReservationAllowed": "Is reservation allowed"
    }
  ]
}

Response

The payload returned by the POST operation has the following format:

{
    "header": {
        "apiName": "API Name",
        "apiVersion": "version of the API",
        "correlationId": "Correlation ID in DALI"
    },
    "data": {
        "code": Status Code,
        "message": "Status Message"
    },
    "pagination": {},
    "error": {}
}